home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / lockdoor.zip / LOCKDOOR.DOC < prev    next >
Text File  |  1992-10-02  |  10KB  |  283 lines
  1.  
  2.  
  3.  
  4.  
  5.         ╓───────────────────────────────────────────────────────────╖
  6.         ║                                                           ║
  7.         ║                      LockDoor                             ║
  8.         ║              (A PCBoard   14.5 Utility)                   ║
  9.         ║                                                           ║
  10.         ║                LockDoor Version 1.3                       ║
  11.         ║                                                           ║
  12.         ║          Copyright (C) 1992 by David D. Casto             ║
  13.         ║                 ALL RIGHTS RESERVED                       ║
  14.         ║                                                           ║
  15.         ║               6196  Deewood Loop East                     ║
  16.         ║                Columbus, Ohio  43229                      ║
  17.         ║                   (614)  882-0994                         ║
  18.         ║                                                           ║
  19.         ╙───────────────────────────────────────────────────────────╜
  20.  
  21.  
  22.    LockDoor Version 1.3  -  LockDoor.DOC  -  USER MANUAL               Page - II
  23. -----------------------------------------------------------------------------
  24.  
  25.  
  26.  
  27.  
  28. Table Of Contents:
  29. =================
  30.  
  31.  
  32.  
  33.         Cover Page ..........................................  I
  34.  
  35.         Table Of Contents ................................... II
  36.  
  37.         Legal Information ...................................  1
  38.  
  39.         Registration ........................................  1
  40.  
  41.         Program Description .................................  2
  42.  
  43.         How LockDoor Works ..................................  2
  44.  
  45.         Set Up ..............................................  2
  46.  
  47.         Example Door Batch Files ............................  3
  48.  
  49.         Example Display File ................................  4
  50.  
  51.         Comments ............................................  4
  52.  
  53.         What's New ..........................................  5
  54.  
  55.  
  56.  
  57.  
  58.  LockDoor Version 1.3  -  LockDoor.DOC  -  USER MANUAL               Page - 1
  59. -----------------------------------------------------------------------------
  60.  
  61.                           LockDoor Version 1.3
  62.                    Copyright (C) 1992 by David D. Casto
  63.                           ALL RIGHTS RESERVED
  64.                         6196 Deewood Loop East
  65.                          Columbus, Ohio 43229
  66.                             (614)  882-0994
  67.  
  68.  
  69.  
  70.  WARNING!!
  71.  -------
  72.  
  73.         As with all new software it is *STRONGLY* recommended that you have a
  74.      recent backup just in case.
  75.  
  76.  
  77.  Legal:
  78.  -----
  79.  
  80.         David Casto hereby disclaims all warranties relating to this
  81.      software, whether express or implied, including without limitation any
  82.      implied warranties of merchantability or fitness for a particular
  83.      purpose. David Casto will not be liable for any special, incidental,
  84.      consequential, indirect or similar damages due to loss of data or any
  85.      other reason, even if David Casto or an agent of David Casto has been
  86.      advised of the possibility of such damages.  In no event shall David
  87.      Casto liability for any damages ever exceed the price paid for the
  88.      license to use software, regardless of the form of the claim.  The
  89.      person using the software bears all risk as to the quality and
  90.      performance of the software.
  91.  
  92.         You are free to distribute this software as long as there are no
  93.      modifications to any files in this Archive.
  94.  
  95.  
  96.  Registration:
  97.  
  98.       LockDoor is a free utility to all registered PCBEvent users.  LockDoor
  99.      will not work unless you have a registered PCBEvent key!
  100.  
  101.  
  102.  LockDoor Version 1.3  -  LockDoor.DOC  -  USER MANUAL               Page - 2
  103. -----------------------------------------------------------------------------
  104.  
  105.  
  106.  What Is LockDoor? :
  107.  =================
  108.  
  109.      LockDoor is a utility that will lock a door xx minuets before an event
  110.      preventing event over run.
  111.  
  112.  
  113.  How LockDoor Works:
  114.  ==================
  115.  
  116.         LockDoor reads PCBEvent.cfg to determine the path to the node's home
  117.     directory.  LockDoor then reads PCBoard.dat and calculates the time
  118.     remaining until your next event.  If the time remaining is equal to or
  119.     less than the xx minuets that was specified on the command line, an
  120.     errorlevel of 10 will be returned to DOS.  The errorlevel is then checked
  121.     by your door batch file.  In the example door batch file below, if the
  122.     errorlevel is 10 then it will go to the LOCK label, copy DoorLock.txt to
  123.     PCBDoor.txt and reload the board.  PCBoard will then display DoorLock.txt
  124.     to the user.  If the time remaining is greater than the time specified on
  125.     the command line an errorlevel of 0 is returned to DOS therefore by-
  126.     passing the LOCK and opening the door.
  127.  
  128.  
  129.  
  130.  Setup:
  131.  =====
  132.  
  133.    1.) Place LockDoor.exe in your PCBEvent directory.  Make LockDoor.exe read
  134.        only (See ReadOnly.doc).  You should have the SET PCBEvent environment
  135.        variable installed in your environment and the PCBEvent directory
  136.        should be in your DOS path.  If you have set up PCBEvent with the SET
  137.        PCBEvent environment variable, and have the PCBEvent directory in your
  138.        DOS path you can run LockDoor from any directory.  If you do not have
  139.        PCBEvent set up with the DOS environment variable and the PCBEvent
  140.        directory is not in your DOS path, you will need to execute LockDoor
  141.        from the PCBEvent directory.
  142.  
  143.    2.) Edit each door batch file that you want to use LockDoor on.  (see
  144.        batch file examples).
  145.  
  146.    3.) Place and edit a LockDoor.txt (or any Path\FileName) in a directory
  147.        (see example).
  148.  
  149.    4.) Please let me know if you like LockDoor!
  150.  
  151.  
  152.  LockDoor Version 1.3  -  LockDoor.DOC  -  USER MANUAL               Page - 3
  153. -----------------------------------------------------------------------------
  154.  
  155.  
  156. Example Door Batch Files For Node 1:
  157. ===================================
  158.  
  159.       --------------------------
  160.        Regular Door Batch File:
  161.       --------------------------
  162.         @ECHO OFF
  163.         LockDoor 1:45:Y
  164.         IF ERRORLEVEL == 10 GOTO LOCK
  165.         CD\MYDOOR
  166.         MYDOOR
  167.         GOTO END
  168.         :LOCK
  169.         COPY C:\PCB\GEN\LockDoor.txt C:\PCB\PCBDOOR.txt>NUL
  170.         :END
  171.         C:
  172.         CD\PCB
  173.         BOARD
  174.  
  175.  
  176.       ------------------------
  177.        Shell Door Batch File:
  178.       ------------------------
  179.         @ECHO OFF
  180.         LockDoor 1:45:Y
  181.         IF ERRORLEVEL == 10 GOTO LOCK
  182.         CD\MYDOOR
  183.         MYDOOR
  184.         GOTO END
  185.         :LOCK
  186.         COPY C:\PCB\GEN\LockDoor.txt C:\PCB\PCBDOOR.txt>NUL
  187.         :END
  188.         C:
  189.         CD\PCB
  190.         EXIT
  191.  
  192.  
  193.  
  194.  
  195.  LockDoor Version 1.3  -  LockDoor.DOC  -  USER MANUAL               Page - 4
  196. -----------------------------------------------------------------------------
  197.  
  198.  
  199. Example LockDoor.txt:
  200. ==================
  201.  
  202. @CLS@@BEEP@@BEEP@@BEEP@
  203. @X0C────────────────────────────────────────────────────────────────────────────
  204.  
  205.                                @X8CPLEASE NOTE
  206.  
  207.              @X0FThis door has been @X0CLOCKED @X0Fdue to a scheduled event.
  208.  
  209.              Please try this door again after our event at @EVENT@.
  210.  
  211.  
  212.                                  Thank You
  213.  
  214.                                  Your SysOp
  215.  
  216. @X0C────────────────────────────────────────────────────────────────────────────
  217.  
  218. @WAIT@
  219.  
  220.  
  221.  
  222.  
  223.  Comments:
  224.  ========
  225.  
  226.         LockDoor was constructed due to several doors that do not check the
  227.     next event time.  This can result in a user being in a door and therefor
  228.     over running an event.
  229.  
  230.         If you have any problems installing LockDoor or any of my doors or
  231.     utilities feel free to call me voice at 614-882-0994.  I monitor the DOOR
  232.     and UTILITY conferences on Salt Air.  I also monitor the Rime PCBHints
  233.     conference.
  234.  
  235.       * Note:  Please address all correspondence to David Casto.
  236.  
  237.       *****************************************************************
  238.  
  239.                Blue Light BBS is located in Columbus, Ohio
  240.                        Support Conference #99
  241.  
  242.                       (614) 766-9708 14400 BPS
  243.                       (614) 766-9709 19200 BPS
  244.  
  245.  
  246.  LockDoor Version 1.3  -  LockDoor.DOC  -  USER MANUAL               Page - 5
  247. -----------------------------------------------------------------------------
  248.  
  249. What's NEW:
  250. ==========
  251.  
  252.   Version 1.0
  253.   -----------
  254.  
  255.         Initial release.
  256.  
  257.  
  258.   Version 1.1
  259.   -----------
  260.  
  261.  
  262.         Added - Will now read the PCBEvent.cfg and the environment to get the
  263.    needed information without Door.sys.
  264.  
  265.         Added - There are now three command line parameters.  The syntax is
  266.    "LockDoor NodeNumber:Min:OverRide".  The NodeNumber is the Node Number
  267.    that is running LockDoor.  NodeNumber may be a DOS SET variable.  Min is
  268.    the Minuets before the event to disable the door.  OverRide is a "Y" or
  269.    "N" (Y for yes and N for no).  OverRide will over ride the event checking
  270.    if the next event is set to Slide if user is on-line.  Default OverRide is
  271.    NO and is not required on the command line.
  272.  
  273.         Added - Several other small cosmetic changes.
  274.  
  275.   Version 1.3
  276.   -----------
  277.  
  278.         Added - Ability to read the new PCBEvent key files.
  279.  
  280.         Added - Ability to read the New PCBEvent environment variables.
  281.  
  282.         Removed - High Color screen displays.
  283.